vergen
Generate build
, git
, rustc
, cargo
, and sysinfo
related cargo:rustc-env
instructions via build.rs
for use in your code via the env!
macro or option_env!
macro.
Sponsors
Special thanks to the sponsors of this project
Release 7.0 Breaking Changes
chrono
has been replaced withtime
. Thetime
crate is better maintained.- The local timezone support in the
build
andgit
features has been moved behind alocal_offset
feature flag. This is due to a potential segfault when usinglocaltime_r
as thetime
crate does. - To build with the
local_offset
feature, you must also explicitly delare that you are acknowledging the potential unsoundness by settingRUSTFLAGS="--cfg unsound_local_offset"
. Per thetime
docs this isn't tested, so use with extreme caution.
Notes about git 0.15
This update to git picked up some security related features. In docker environments especially, this requires a safe.directory
configuration. There are a couple methods for achieving this.
- If you control the build, you can add
git config --global --add safe.directory /workspace
to the build file. - If you do not control the docker build, you can add
git config --global --add safe.directory /workspace &&
before the actual command you are running when using docker run. - If you do not control the docker build, you can mount a
.gitconfig
file at/root
that includes thesafe.directory
configuration. I use this method myself when building static binaries with clux/muslrust.
docker run -v cargo-cache:/root/.cargo/registry -v (pwd):/volume -v ~/.gitconfig:/root/.gitconfig:ro --rm -t clux/muslrust:stable cargo build --release
See https://github.com/rustyhorde/vergen/pull/126 for more discussion on the topic. If the solutions above do not work for your usecase, you can pin your vergen
version to 7.4.3. Feel free to open issues about this. If it comes up enough, I could support a version of vergen
with the older git2
dependency.
MSRV
The current minimum supported rust version is 1.63.0
Current Release
Example Usage
See the documentation at docs.rs for example usage
Environment Variables
A full list of environment variables that can be generated are listed in the following table.
Variable | Sample |
---|---|
VERGEN_BUILD_DATE |
2021-02-25 |
VERGEN_BUILD_TIME |
23:28:39.493201 |
VERGEN_BUILD_TIMESTAMP |
2021-02-25T23:28:39.493201+00:00 |
VERGEN_BUILD_SEMVER |
5.0.0 |
VERGEN_GIT_BRANCH |
feature/fun |
VERGEN_GIT_COMMIT_AUTHOR_EMAIL |
janedoe@email.com |
VERGEN_GIT_COMMIT_AUTHOR_NAME |
Jane Doe |
VERGEN_GIT_COMMIT_COUNT |
330 |
VERGEN_GIT_COMMIT_DATE |
2021-02-24 |
VERGEN_GIT_COMMIT_MESSAGE |
feat: add commit messages |
VERGEN_GIT_COMMIT_TIME |
20:55:21 |
VERGEN_GIT_COMMIT_TIMESTAMP |
2021-02-24T20:55:21+00:00 |
VERGEN_GIT_SEMVER |
5.0.0-2-gf49246c |
VERGEN_GIT_SHA |
f49246ce334567bff9f950bfd0f3078184a2738a |
VERGEN_RUSTC_CHANNEL |
nightly |
VERGEN_RUSTC_COMMIT_DATE |
2021-02-24 |
VERGEN_RUSTC_COMMIT_HASH |
a8486b64b0c87dabd045453b6c81500015d122d6 |
VERGEN_RUSTC_HOST_TRIPLE |
x86_64-apple-darwin |
VERGEN_RUSTC_LLVM_VERSION |
11.0 |
VERGEN_RUSTC_SEMVER |
1.52.0-nightly |
VERGEN_CARGO_FEATURES |
git,build |
VERGEN_CARGO_PROFILE |
debug |
VERGEN_CARGO_TARGET_TRIPLE |
x86_64-unknown-linux-gnu |
VERGEN_SYSINFO_NAME |
Manjaro Linux |
VERGEN_SYSINFO_OS_VERSION |
Linux Manjaro Linux |
VERGEN_SYSINFO_USER |
Yoda |
VERGEN_SYSINFO_TOTAL_MEMORY |
33 GB |
VERGEN_SYSINFO_CPU_VENDOR |
Authentic AMD |
VERGEN_SYSINFO_CPU_CORE_COUNT |
8 |
VERGEN_SYSINFO_CPU_NAME |
cpu0,cpu1,cpu2,cpu3,cpu4,cpu5,cpu6,cpu7 |
VERGEN_SYSINFO_CPU_BRAND |
AMD Ryzen Threadripper 1900X 8-Core Processor |
VERGEN_SYSINFO_CPU_FREQUENCY |
3792 |
Contributing
See the documentation at CONTRIBUTING.md
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT) at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.